GET api/PropertiesHierarchy?ids[0]={ids[0]}&ids[1]={ids[1]}&PropertyStatus={PropertyStatus}

Get properties Hierarchy(manager, district manager and team leader) from a specific market with a provided list of property IDs

Request Information

Authentication

This method requires user authentication

URI Parameters

Name	Description	Type	Additional information
ids	(Optional) if no id is passed then the route will return the info for all properties linked to the user	Collection of integer	Required
PropertyStatus	(Optional) if no value is passed then the route will return the info for all Active properties linked to the user	string	Active

Body Parameters

None.

Response Information

Resource Description

ListWrapperOfPropertyHierarchy

Name	Description	Type	Additional information
Total		integer	None.
Elements		Collection of PropertyHierarchy	None.

Response Formats

application/json, text/json

Sample:

{
  "Total": 1,
  "Elements": [
    {
      "PropertyId": 1,
      "PropertyManager": {
        "UserId": 1,
        "UserTypeId": 1,
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "Email": "sample string 4",
        "CellPhone": "sample string 5",
        "OtherPhone": "sample string 6",
        "Pager": "sample string 7",
        "Fax": "sample string 8",
        "Extension": "sample string 9",
        "TitleId": 1,
        "HomePhone": "sample string 10",
        "AlternateTitle": "sample string 11"
      },
      "DistrictManager": {
        "UserId": 1,
        "UserTypeId": 1,
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "Email": "sample string 4",
        "CellPhone": "sample string 5",
        "OtherPhone": "sample string 6",
        "Pager": "sample string 7",
        "Fax": "sample string 8",
        "Extension": "sample string 9",
        "TitleId": 1,
        "HomePhone": "sample string 10",
        "AlternateTitle": "sample string 11"
      },
      "TeamLeader": {
        "UserId": 1,
        "UserTypeId": 1,
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "Email": "sample string 4",
        "CellPhone": "sample string 5",
        "OtherPhone": "sample string 6",
        "Pager": "sample string 7",
        "Fax": "sample string 8",
        "Extension": "sample string 9",
        "TitleId": 1,
        "HomePhone": "sample string 10",
        "AlternateTitle": "sample string 11"
      }
    },
    {
      "PropertyId": 1,
      "PropertyManager": {
        "UserId": 1,
        "UserTypeId": 1,
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "Email": "sample string 4",
        "CellPhone": "sample string 5",
        "OtherPhone": "sample string 6",
        "Pager": "sample string 7",
        "Fax": "sample string 8",
        "Extension": "sample string 9",
        "TitleId": 1,
        "HomePhone": "sample string 10",
        "AlternateTitle": "sample string 11"
      },
      "DistrictManager": {
        "UserId": 1,
        "UserTypeId": 1,
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "Email": "sample string 4",
        "CellPhone": "sample string 5",
        "OtherPhone": "sample string 6",
        "Pager": "sample string 7",
        "Fax": "sample string 8",
        "Extension": "sample string 9",
        "TitleId": 1,
        "HomePhone": "sample string 10",
        "AlternateTitle": "sample string 11"
      },
      "TeamLeader": {
        "UserId": 1,
        "UserTypeId": 1,
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "Email": "sample string 4",
        "CellPhone": "sample string 5",
        "OtherPhone": "sample string 6",
        "Pager": "sample string 7",
        "Fax": "sample string 8",
        "Extension": "sample string 9",
        "TitleId": 1,
        "HomePhone": "sample string 10",
        "AlternateTitle": "sample string 11"
      }
    }
  ]
}

Internal Error Codes

106: ResourceNotFound
(The requested resource was not found., NotFound)
100: MissingRequiredHeader
(Invalid request format. A required HTTP header was not specified., BadRequest)
118: InvalidHeaderValue
(The value provided for one of the HTTP headers was not in the correct format., BadRequest)
199: UnknownError
(Internal server error., InternalServerError)
105: ResourceNotLinkedToUser
(User is trying to access a resource that belongs to a property not linked to the user., Forbidden)